Get Documents
AutomatR.DocuSign.Activities.GetDocuments
The "Get Documents" activity in AutomatR is part of the DocuSign Document activities package, providing the capability to download all documents associated with a DocuSign envelope and save them as a compressed (.zip) file. This activity streamlines the process of retrieving multiple documents from an envelope for further processing within automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Download Directory | Enter the file path of the directory where the downloaded documents should be saved. This field supports only Strings or String variables. Example: "C:\Path\To\Your\Download\Directory\" |
| Envelope ID | Enter the Envelope ID from which documents need to be downloaded. This field supports only Strings or String variables. |
| File Name | Provide a file name for the compressed (.zip) file. This field supports only Strings or String variables. |
| Overwrite | If checked, it enables you to download a file with the same name as the one in the destination location. Boolean variables or Boolean expressions for overwriting existing files. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Documents" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the full path with the name of the compressed (.zip) file containing all downloaded documents. Variables of data type string to store the path. |
How to use:
- Drag and drop the "Get Documents" activity onto the workflow.
- Configure the properties by specifying the Envelope ID, Download Directory, File Name, and optionally, the Delay and Overwrite.
- Execute the workflow to download all documents associated with the specified envelope and save them as a compressed (.zip) file.
Important Note:
- Ensure that the "Get Documents" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Get Documents" activity is used to download all documents from an envelope (Envelope ID: "env456") and save them to the directory "C:\DownloadedDocuments" with the file name "AllDocuments":
Get Documents:
Delay: 5
Envelope ID: "env456"
Download Directory: "C:\DownloadedDocuments"
File Name: "AllDocuments"
Overwrite: true
Response: zipFilePath
In this example, the activity downloads all documents from the envelope with ID "env456" and saves them as a compressed (.zip) file named "AllDocuments.zip" in the directory "C:\DownloadedDocuments." The full path of the created zip file is stored in the variable "zipFilePath" for further handling in the workflow.